doc: Add initial functional specification document#1
Open
ifraixedes wants to merge 1 commit into
Open
Conversation
Create a functional specification document which describes all the `offsync` steps flow. The document contains a sequence diagram for each flow apart of some textual description. This document describe the initial functionality to serve the main purpose. Update the README about how evolved since we wrote it and now. Update the project status and mention about the specification document.
ifraixedes
force-pushed
the
if/doc-offsync-functional-flow
branch
from
23ceb2e to
18563d3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create a functional specification document which describes all the
offsyncsteps flow.The document contains a sequence diagram for each flow apart of some textual description.
This document describe the initial functionality to serve the main purpose.
REMINDER you can see a rendered markdown including the mermaid diagrams by clicking
view filein the 3 dots menu at the top of the file in the File changed tab.